@protobufjs/base64

What is @protobufjs/base64?

@protobufjs/base64 is a utility library for encoding and decoding base64 strings, primarily used in conjunction with Protocol Buffers in JavaScript. It provides efficient and straightforward methods to handle base64 encoding and decoding operations.

What are @protobufjs/base64's main functionalities?

Base64 Encoding

This feature allows you to encode a Uint8Array into a base64 string. The `encode` method takes a buffer, an offset, and a length as parameters.

const base64 = require('@protobufjs/base64');

const buffer = new Uint8Array([72, 101, 108, 108, 111]);
let encoded = base64.encode(buffer, 0, buffer.length);
console.log(encoded); // Outputs: SGVsbG8=

Base64 Decoding

This feature allows you to decode a base64 string back into a Uint8Array. The `decode` method takes a base64 string, a buffer to write to, and an offset as parameters.

const base64 = require('@protobufjs/base64');

const encoded = 'SGVsbG8=';
let buffer = new Uint8Array(encoded.length);
let length = base64.decode(encoded, buffer, 0);
console.log(buffer.subarray(0, length)); // Outputs: Uint8Array(5) [ 72, 101, 108, 108, 111 ]

Other packages similar to @protobufjs/base64

base64-js

The `base64-js` package provides similar functionality for encoding and decoding base64 strings. It is a lightweight and efficient library that is widely used in the JavaScript ecosystem. Compared to @protobufjs/base64, `base64-js` is more general-purpose and not specifically tied to Protocol Buffers.

js-base64

The `js-base64` package is another popular library for base64 encoding and decoding. It offers a simple API and is highly performant. Unlike @protobufjs/base64, `js-base64` includes additional features like URL-safe base64 encoding and decoding.

README

@protobufjs/base64

A minimal base64 implementation for number arrays.

API

• base64.length(string: string): number
  Calculates the byte length of a base64 encoded string.

• base64.encode(buffer: Uint8Array, start: number, end: number): string
  Encodes a buffer to a base64 encoded string.

• base64.decode(string: string, buffer: Uint8Array, offset: number): number
  Decodes a base64 encoded string to a buffer.

License: BSD 3-Clause License